/***
 * ASM: a very small and fast Java bytecode manipulation framework
 * Copyright (c) 2000-2007 INRIA, France Telecom
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *	notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *	notice, this list of conditions and the following disclaimer in the
 *	documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of its
 *	contributors may be used to endorse or promote products derived from
 *	this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.objectweb.asm.tree;

import java.util.Map;

import org.objectweb.asm.MethodVisitor;

/**
 * A node that represents a local variable instruction. A local variable
 * instruction is an instruction that loads or stores the value of a local
 * variable.
 * 
 * @author Eric Bruneton
 */
public class VarInsnNode extends AbstractInsnNode {

	/**
	 * The operand of this instruction. This operand is the index of a local
	 * variable.
	 */
	public int var;

	/**
	 * Constructs a new {@link VarInsnNode}.
	 * 
	 * @param opcode the opcode of the local variable instruction to be
	 *		constructed. This opcode must be ILOAD, LLOAD, FLOAD, DLOAD,
	 *		ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.
	 * @param var the operand of the instruction to be constructed. This operand
	 *		is the index of a local variable.
	 */
	public VarInsnNode(final int opcode, final int var) {
		super(opcode);
		this.var = var;
	}

	/**
	 * Sets the opcode of this instruction.
	 * 
	 * @param opcode the new instruction opcode. This opcode must be ILOAD,
	 *		LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE
	 *		or RET.
	 */
	public void setOpcode(final int opcode) {
		this.opcode = opcode;
	}

	public int getType() {
		return VAR_INSN;
	}

	public void accept(final MethodVisitor mv) {
		mv.visitVarInsn(opcode, var);
	}

	public AbstractInsnNode clone(final Map<?, ?> labels) {
		return new VarInsnNode(opcode, var);
	}
}
